Gradio 中文文档
欢迎来到 Gradio 中文文档项目!
本项目旨在提供 Gradio 框架的中文版文档,帮助中文开发者更方便地学习和使用 Gradio。本文档基于 Gradio 官方文档,并采用 VitePress 构建。
目标
- 准确翻译 Gradio 官方核心文档。
- 提供清晰、易懂的中文示例和说明。
- 根据 Gradio 的更新,及时维护文档内容。
如何贡献
我们欢迎社区成员参与贡献,共同完善中文文档。如果您发现任何错误、有改进建议或愿意参与翻译,请通过 提出 Issue 或 提交 Pull Request 的方式参与。 (请将 your-repo/gradio-docs-cn
替换为您的实际仓库地址)
快速开始 (VitePress)
确保你已经安装了 Node.js (推荐 LTS 版本)。
克隆/创建项目:
bash# 如果是新项目 mkdir gradio-docs-cn cd gradio-docs-cn npm init -y npm add -D vitepress vue mkdir docs echo '# Hello Gradio 中文文档' > docs/index.md
配置
package.json
:json{ "scripts": { "docs:dev": "vitepress dev docs", "docs:build": "vitepress build docs", "docs:preview": "vitepress preview docs" }, "devDependencies": { "vitepress": "^1.0.0-rc.0", // 请使用最新版 "vue": "^3.3.0" // 请使用最新版 } }
注意:请根据实际安装的 VitePress 和 Vue 版本调整上述版本号。
创建 VitePress 配置文件
docs/.vitepress/config.js
:javascriptexport default { title: 'Gradio 中文文档', description: 'Gradio 框架的中文参考文档', themeConfig: { nav: [ { text: '指南', link: '/guide/introduction' }, { text: '核心概念', link: '/core-concepts/interface-class' } ], sidebar: { '/guide/': [ { text: '入门', items: [ { text: '介绍', link: '/guide/introduction' }, { text: '安装', link: '/guide/installation' }, ] } ], '/core-concepts/': [ { text: '核心概念', items: [ { text: 'Interface 类', link: '/core-concepts/interface-class' }, { text: 'Blocks', link: '/core-concepts/blocks' }, ] } ] } } }
创建文档页面:
docs/guide/introduction.md
(介绍)docs/guide/installation.md
(安装)docs/core-concepts/interface-class.md
(Interface 类)docs/core-concepts/blocks.md
(Blocks)- ... 其他文档页面
运行开发服务器:
bashnpm run docs:dev